api: Add unreadMsgs in initial snapshot #266
Conversation
lib/api/model/initial_snapshot.dart
Outdated
| final String topic; | ||
| final int streamId; | ||
| final List<int> unreadMessageIds; | ||
| // final List<int> senderIds; // deprecated; ignore |
There was a problem hiding this comment.
| // final List<int> senderIds; // deprecated; ignore |
This one isn't merely deprecated but (at least according to the docs) actually absent for current servers, so in particular it's only documented within a "Changes" note:
Because it's not in the main line of the documentation, we don't need to specifically mention that we've looked at it and consciously chosen not to put it in the type.
lib/api/model/initial_snapshot.dart
Outdated
| /// An item in `unread_msgs.pms`. | ||
| /// | ||
| /// For docs, search for "unread_msgs:" and see "pms:" | ||
| /// in <https://zulip.com/api/register-queue>. |
There was a problem hiding this comment.
nit:
| /// An item in `unread_msgs.pms`. | |
| /// | |
| /// For docs, search for "unread_msgs:" and see "pms:" | |
| /// in <https://zulip.com/api/register-queue>. | |
| /// An item in [UnreadMessagesSnapshot.dms]. |
(and similarly the other two below)
I think once you search for "unread_msgs:" and are looking at that section, it's easy to find the individual subsections for these pieces of it. Also if you're looking at any one of them it's quite likely you're looking at other parts of unread_msgs anyway.
Conversely it's nice to draw the links between these types explicitly, and to keep them each compact the better to have several of them on screen at the same time.
chrisbobbe
force-pushed
the
pr-unread-msgs-snapshot
branch
from
553f9a8 to
bc6e72a
Compare
|
Thanks! Revision pushed. |
chrisbobbe
changed the title
Our own data structure in PerAccountStore will be constructed from this value, and it will probably have quite a different shape; for example, there, we're likely to want to collapse the distinction between 1:1 and group DMs. But now we're validating this part of the /register response and making it available to feed into those new internal data structures. Related: zulip#253
|
Thanks! Looks good; merging. |
gnprice
force-pushed
the
pr-unread-msgs-snapshot
branch
from
bc6e72a to
e7073c2
Compare
Our own data structure in PerAccountStore will be constructed from this value, and it will probably have quite a different shape; for example, we're likely to want to collapse the distinction between 1:1 and group DMs.
But now we're validating this part of the /register response and making it available to feed into those new internal data structures.
Related: #253